chore: reorganize `tsconfig` files for clarity by ulissesferreira · Pull Request #257 · MetaMask/internal-snaps

ulissesferreira · 2026-09-02T16:16:42Z

Explanation

One more clarity improving PR for the tsconfig files on our repository so anyone can understand what is happening under the hood and keeping as many similarities as possible with core. The hierarchy of the config files is explained below but I believe that with their names and comments inside it should be self explanatory. Please raise if this is not extremely intuitive.

tsconfig.base.json                              - Configurations shared by all `tsconfig` files
│
├── tsconfig.json                               - Repository root configuration
├── tsconfig.scripts.json                       - Used for the `scripts/` directory
└── tsconfig.packages.json                      - Shared by all `packages/`, whether Snaps or not
    │
    ├── 👻 tsconfig.packages.libs.json     - Not needed because it's the same thing as
    │                                             `tsconfig.packages.json`
    ├── tsconfig.packages.libs.build.json  - Needed changed for the emission of
    │                                             declarations
    │
    ├── tsconfig.packages.snaps.json            - Snap specific configurations
    └── 👻 tsconfig.packages.snaps.build.json   - Not needed because mm-snap handles
                                                    everything automatically

References

Checklist

I've updated the test suite for new or updated code as appropriate
I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
I've communicated my changes to consumers by updating changelogs for packages I've changed
I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

taran-a

LGTM. GG

mikesposito · 2026-09-03T06:44:16Z

+  /**
+   * Unlike Snap's which include all TypeScript, TSX and JSON files, here we want
+   * to mirror what gets built.
+   */
+  "include": ["./src"]


curious about why was this change needed

Same as before, removing the unused types entry and the exclude is inherited from the shared tsconfig's above

mikesposito · 2026-09-03T06:45:06Z

+  /**
+   * Unlike Snap's which include all TypeScript, TSX and JSON files, here we want
+   * to mirror what gets built.
+   */
+  "include": ["./src"]


curious about why was this change needed

So what that line is doing is making sure that TypeScript is only applied to the actual src files instead of also including things under the whole package folder. Not including it would add more than actually needs to be checked.

However I have realized one thing. Instead of specifying what we want included, I think it would be best to specify what we exclude because if in the future we add a scripts folder inside here or if we change some config files to use TS instead of JS, we want to already be typechecking those.

This last comment does not apply to the build though. For the build we want to specify exactly what is being included and therefore being include-first is the best approach to avoid shipping bloat in the package.

Also the precious line, which add a ../../types was pointing to something that didn't exist 😅

taran-a · 2026-09-03T09:16:10Z

Hi @ulissesferreira, spotted this comment in the core PR MetaMask/core#10019

it is related to the target ES2023, which is not supported in ReactNative, maybe it is irrelevant for snaps, but worth checking

ulissesferreira · 2026-09-03T09:22:19Z

Hi @ulissesferreira, spotted this comment in the core PR MetaMask/core#10019

it is related to the target ES2023, which is not supported in ReactNative, maybe it is irrelevant for snaps, but worth checking

Thank you for the thoughtfulness! As part of this work I am asking the Snaps team to have a look and tell us if they like the configurations for Snaps. For our library package I guess the same thing kind of applies. I was expecting whatever bundler used by the clients to handle that actually, kinda surprised Core has to be the repository that implements that.

ulissesferreira · 2026-09-03T10:30:49Z

  },
  "files": [],
-  "include": ["./docs", "./tests", "./scripts"],
-  "exclude": ["**/node_modules"]


This is already a tsc default, unnecessary.

ulissesferreira · 2026-09-03T10:36:19Z

-    "locales/*.json",
-    "snap.manifest.json",
-    "src/**/*.json"
-  ]


Simplify...

ulissesferreira requested review from a team as code owners September 2, 2026 16:16

ulissesferreira deployed to default-branch September 2, 2026 16:16 — with GitHub Actions Active

ulissesferreira added the no-changelog label Sep 2, 2026

ulissesferreira force-pushed the chore/rename-and-reorganize-tsconfig-files branch 3 times, most recently from b58adfc to a754be9 Compare September 2, 2026 16:39

ulissesferreira mentioned this pull request Sep 2, 2026

chore: support creating Snaps and libraries with create-package #258

Merged

taran-a previously approved these changes Sep 2, 2026

View reviewed changes

Battambang reviewed Sep 2, 2026

View reviewed changes

Comment thread scripts/create-package/package-template/tsconfig.build.json Outdated

Battambang reviewed Sep 2, 2026

View reviewed changes

Comment thread scripts/create-package/package-template/tsconfig.json Outdated

mikesposito reviewed Sep 3, 2026

View reviewed changes

Comment thread tsconfig.packages.libs.build.json

mikesposito reviewed Sep 3, 2026

View reviewed changes

Comment thread tsconfig.packages.non-snaps.build.json Outdated

mikesposito reviewed Sep 3, 2026

View reviewed changes

Comment thread AGENTS.md Outdated

mikesposito reviewed Sep 3, 2026

View reviewed changes

ulissesferreira dismissed taran-a’s stale review via 56eb328 September 3, 2026 09:06

ulissesferreira force-pushed the chore/rename-and-reorganize-tsconfig-files branch 4 times, most recently from 748bb61 to 17ebfdd Compare September 3, 2026 09:10

ulissesferreira force-pushed the chore/rename-and-reorganize-tsconfig-files branch from 17ebfdd to 427d4b6 Compare September 3, 2026 09:17

ulissesferreira force-pushed the chore/rename-and-reorganize-tsconfig-files branch 2 times, most recently from effb589 to 8a31ec9 Compare September 3, 2026 10:27

ulissesferreira commented Sep 3, 2026

View reviewed changes

chore: reorganize tsconfig files for clarity

42d9b09

ulissesferreira force-pushed the chore/rename-and-reorganize-tsconfig-files branch from 8a31ec9 to 42d9b09 Compare September 3, 2026 10:39

taran-a approved these changes Sep 3, 2026

View reviewed changes

ulissesferreira added this pull request to the merge queue Sep 3, 2026

Merged via the queue into main with commit b8e5aba Sep 3, 2026
54 checks passed

ulissesferreira deleted the chore/rename-and-reorganize-tsconfig-files branch September 3, 2026 11:05

Uh oh!

Conversation

ulissesferreira commented Sep 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

References

Checklist

Uh oh!

taran-a left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ulissesferreira Sep 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

taran-a commented Sep 3, 2026

Uh oh!

ulissesferreira commented Sep 3, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ulissesferreira commented Sep 2, 2026 •

edited

Loading

ulissesferreira Sep 3, 2026 •

edited

Loading